Skip to main content

FlowMail Properties

An object defining properties for the FlowMail class.

UserGroups​

A list of user groups included in the workflow mail group.

Type: List<IMembersUserGroups>


Caption​

The caption dictionary representing localized captions for the flow object.

Type: Dictionary<string, string>


EnablePushNotification​

Gets or sets a value indicating whether push notification is enabled.

Type: bool


ShowInFlowHistory​

Specifies whether this mail step should appear in the workflow history.

Type: bool


DetailObjects​

A list of detail objects associated with the workflow mail group.

Type: List<IMembersDetailObjects>


NotificationMessage​

Gets the notification message associated with the message.

Type: Dictionary<string, string>


MailSubject​

Gets the mail subject associated with the message.

Type: Dictionary<string, string>


DepartmentBasedUserGroups​

A list of department-based user groups included in the workflow mail group.

Type: List<IMembersDepartmentBasedUserGroups>


Key​

A unique identifier for the workflow step.

Type: string


Name​

Name for the workflow step.

Type: string


EnableSendMail​

Gets or sets a value indicating whether sending mail is enabled.

Type: bool


TableObjects​

A list of table objects associated with the workflow mail group.

Type: List<IMembersTableObjects>


MailMessage​

Gets the mail message associated with the message.

Type: Dictionary<string, string>


VariablePositions​

A list of variable positions included in the workflow mail group.

Type: List<IMembersVariablePositions>


ConstantPositions​

A list of constant positions included in the workflow mail group.

Type: List<IMembersConstantPositions>


IsCustomMailMessage​

Gets or sets a value indicating whether the mail message is custom.

Type: bool


CustomMailMessage​

Gets the custom mail message associated with the message.

Type: Dictionary<string, string>


MessageOptions​

Gets or sets the message options.

Type: IFlowMessageOptions


WorkflowCodeInstance​

The workflow code instance associated with the flow object.

Type: IWorkflowCode


Documents​

A list of documents associated with the workflow mail group.

Type: List<IDocument>


CachedDMObjects​

The cached document management objects related to the flow object.

Type: IRuntimeDMObjects


WebNotificationOptions​

Gets or sets the web notification options.

Type: IFlowWebNotificationOptions


IncludeFlowInitiator​

Determines whether to include the workflow initiator in the mail group.

Type: bool


NotificationCaption​

Gets the notification caption associated with the message.

Type: Dictionary<string, string>


Attachments​

Gets the list of attachments associated with the message.

Type: IReadOnlyList<string>


TypeCode​

The type code associated with the flow object.

Type: WorkflowItemTypeCode
Accepted Values:

NameValue
FlowComment-1
FlowStart10
FlowEnd11
FlowPosition15
FlowAssign21
FlowCompare22
FlowOr24
FlowAnd25
FlowMail26
FlowProfession27
FlowDepartment28
Variable30
FlowScript31
FlowNode33
FlowGroup37
FlowTimer39
FlowTimerStarter40
FlowTimerStopper41
FlowApprovalCancellar42
Pauser44
SubFlowCall51
SubFlowBegin52
SubFlowEnd53
FlowPushNotification54
FlowDocument56
FlowCreateDocument57
FlowDocumentSynchronizer58
FlowStarterPosition59
FlowDocumentState63
FlowUniqueIdCreator65
FlowSetDocumentId66
FlowDeleteDocument67
FlowPDFExport68
FlowXMLExport69
FlowMailSender75
FlowParallel79
FlowContinue80
FlowTrigger81
FlowActionCreator82
FlowDigitallySigning83
FlowGptPrompt84

Users​

A list of resolved users in the workflow mail group.

Type: List<UserInfo>


IncludeDocumentApproversOrRefusers​

Specifies whether to include document approvers or refusers in the workflow mail group.

Type: bool


Members​

Defines the configuration for members in the workflow mail group.

Type: IFlowMembersOptions


NotificationOptions​

Gets or sets the push notification options.

Type: IFlowPushNotificationOptions